<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io.output;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.FileNotFoundException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.FileOutputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.OutputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.OutputStreamWriter;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.StringWriter;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.Writer;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Locale;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.regex.Matcher;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.regex.Pattern;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.commons.io.IOUtils;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.commons.io.input.XmlStreamReader;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Character stream that handles all the necessary Voodoo to figure out the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * charset encoding of the XML document written to the stream.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @see XmlStreamReader<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @since 2.0<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class XmlStreamWriter extends Writer {<a name="line.41"></a>
<span class="sourceLineNo">042</span>    private static final int BUFFER_SIZE = IOUtils.DEFAULT_BUFFER_SIZE;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    private final OutputStream out;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>    private final String defaultEncoding;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    private StringWriter xmlPrologWriter = new StringWriter(BUFFER_SIZE);<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    private Writer writer;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    private String encoding;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * Constructs a new XML stream writer for the specified output stream<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * with a default encoding of UTF-8.<a name="line.56"></a>
<span class="sourceLineNo">057</span>     *<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @param out The output stream<a name="line.58"></a>
<span class="sourceLineNo">059</span>     */<a name="line.59"></a>
<span class="sourceLineNo">060</span>    public XmlStreamWriter(final OutputStream out) {<a name="line.60"></a>
<span class="sourceLineNo">061</span>        this(out, null);<a name="line.61"></a>
<span class="sourceLineNo">062</span>    }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>    /**<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * Constructs a new XML stream writer for the specified output stream<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * with the specified default encoding.<a name="line.66"></a>
<span class="sourceLineNo">067</span>     *<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * @param out The output stream<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @param defaultEncoding The default encoding if not encoding could be detected<a name="line.69"></a>
<span class="sourceLineNo">070</span>     */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public XmlStreamWriter(final OutputStream out, final String defaultEncoding) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        this.out = out;<a name="line.72"></a>
<span class="sourceLineNo">073</span>        this.defaultEncoding = defaultEncoding != null ? defaultEncoding : "UTF-8";<a name="line.73"></a>
<span class="sourceLineNo">074</span>    }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * Constructs a new XML stream writer for the specified file<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * with a default encoding of UTF-8.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param file The file to write to<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @throws FileNotFoundException if there is an error creating or<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * opening the file<a name="line.82"></a>
<span class="sourceLineNo">083</span>     */<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public XmlStreamWriter(final File file) throws FileNotFoundException {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        this(file, null);<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Constructs a new XML stream writer for the specified file<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * with the specified default encoding.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @param file The file to write to<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @param defaultEncoding The default encoding if not encoding could be detected<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @throws FileNotFoundException if there is an error creating or<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * opening the file<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span>    @SuppressWarnings("resource")<a name="line.97"></a>
<span class="sourceLineNo">098</span>    public XmlStreamWriter(final File file, final String defaultEncoding) throws FileNotFoundException {<a name="line.98"></a>
<span class="sourceLineNo">099</span>        this(new FileOutputStream(file), defaultEncoding);<a name="line.99"></a>
<span class="sourceLineNo">100</span>    }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>    /**<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * Returns the detected encoding.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     *<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @return the detected encoding<a name="line.105"></a>
<span class="sourceLineNo">106</span>     */<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public String getEncoding() {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        return encoding;<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>    /**<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * Returns the default encoding.<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @return the default encoding<a name="line.114"></a>
<span class="sourceLineNo">115</span>     */<a name="line.115"></a>
<span class="sourceLineNo">116</span>    public String getDefaultEncoding() {<a name="line.116"></a>
<span class="sourceLineNo">117</span>        return defaultEncoding;<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * Closes the underlying writer.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     *<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @throws IOException if an error occurs closing the underlying writer<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span>    public void close() throws IOException {<a name="line.126"></a>
<span class="sourceLineNo">127</span>        if (writer == null) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>            encoding = defaultEncoding;<a name="line.128"></a>
<span class="sourceLineNo">129</span>            writer = new OutputStreamWriter(out, encoding);<a name="line.129"></a>
<span class="sourceLineNo">130</span>            writer.write(xmlPrologWriter.toString());<a name="line.130"></a>
<span class="sourceLineNo">131</span>        }<a name="line.131"></a>
<span class="sourceLineNo">132</span>        writer.close();<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * Flushes the underlying writer.<a name="line.136"></a>
<span class="sourceLineNo">137</span>     *<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * @throws IOException if an error occurs flushing the underlying writer<a name="line.138"></a>
<span class="sourceLineNo">139</span>     */<a name="line.139"></a>
<span class="sourceLineNo">140</span>    @Override<a name="line.140"></a>
<span class="sourceLineNo">141</span>    public void flush() throws IOException {<a name="line.141"></a>
<span class="sourceLineNo">142</span>        if (writer != null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span>            writer.flush();<a name="line.143"></a>
<span class="sourceLineNo">144</span>        }<a name="line.144"></a>
<span class="sourceLineNo">145</span>    }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>    /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * Detects the encoding.<a name="line.148"></a>
<span class="sourceLineNo">149</span>     *<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * @param cbuf the buffer to write the characters from<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @param off The start offset<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @param len The number of characters to write<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @throws IOException if an error occurs detecting the encoding<a name="line.153"></a>
<span class="sourceLineNo">154</span>     */<a name="line.154"></a>
<span class="sourceLineNo">155</span>    private void detectEncoding(final char[] cbuf, final int off, final int len)<a name="line.155"></a>
<span class="sourceLineNo">156</span>            throws IOException {<a name="line.156"></a>
<span class="sourceLineNo">157</span>        int size = len;<a name="line.157"></a>
<span class="sourceLineNo">158</span>        final StringBuffer xmlProlog = xmlPrologWriter.getBuffer();<a name="line.158"></a>
<span class="sourceLineNo">159</span>        if (xmlProlog.length() + len &gt; BUFFER_SIZE) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>            size = BUFFER_SIZE - xmlProlog.length();<a name="line.160"></a>
<span class="sourceLineNo">161</span>        }<a name="line.161"></a>
<span class="sourceLineNo">162</span>        xmlPrologWriter.write(cbuf, off, size);<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>        // try to determine encoding<a name="line.164"></a>
<span class="sourceLineNo">165</span>        if (xmlProlog.length() &gt;= 5) {<a name="line.165"></a>
<span class="sourceLineNo">166</span>            if (xmlProlog.substring(0, 5).equals("&lt;?xml")) {<a name="line.166"></a>
<span class="sourceLineNo">167</span>                // try to extract encoding from XML prolog<a name="line.167"></a>
<span class="sourceLineNo">168</span>                final int xmlPrologEnd = xmlProlog.indexOf("?&gt;");<a name="line.168"></a>
<span class="sourceLineNo">169</span>                if (xmlPrologEnd &gt; 0) {<a name="line.169"></a>
<span class="sourceLineNo">170</span>                    // ok, full XML prolog written: let's extract encoding<a name="line.170"></a>
<span class="sourceLineNo">171</span>                    final Matcher m = ENCODING_PATTERN.matcher(xmlProlog.substring(0,<a name="line.171"></a>
<span class="sourceLineNo">172</span>                            xmlPrologEnd));<a name="line.172"></a>
<span class="sourceLineNo">173</span>                    if (m.find()) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>                        encoding = m.group(1).toUpperCase(Locale.ROOT);<a name="line.174"></a>
<span class="sourceLineNo">175</span>                        encoding = encoding.substring(1, encoding.length() - 1);<a name="line.175"></a>
<span class="sourceLineNo">176</span>                    } else {<a name="line.176"></a>
<span class="sourceLineNo">177</span>                        // no encoding found in XML prolog: using default<a name="line.177"></a>
<span class="sourceLineNo">178</span>                        // encoding<a name="line.178"></a>
<span class="sourceLineNo">179</span>                        encoding = defaultEncoding;<a name="line.179"></a>
<span class="sourceLineNo">180</span>                    }<a name="line.180"></a>
<span class="sourceLineNo">181</span>                } else if (xmlProlog.length() &gt;= BUFFER_SIZE) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>                    // no encoding found in first characters: using default<a name="line.182"></a>
<span class="sourceLineNo">183</span>                    // encoding<a name="line.183"></a>
<span class="sourceLineNo">184</span>                    encoding = defaultEncoding;<a name="line.184"></a>
<span class="sourceLineNo">185</span>                }<a name="line.185"></a>
<span class="sourceLineNo">186</span>            } else {<a name="line.186"></a>
<span class="sourceLineNo">187</span>                // no XML prolog: using default encoding<a name="line.187"></a>
<span class="sourceLineNo">188</span>                encoding = defaultEncoding;<a name="line.188"></a>
<span class="sourceLineNo">189</span>            }<a name="line.189"></a>
<span class="sourceLineNo">190</span>            if (encoding != null) {<a name="line.190"></a>
<span class="sourceLineNo">191</span>                // encoding has been chosen: let's do it<a name="line.191"></a>
<span class="sourceLineNo">192</span>                xmlPrologWriter = null;<a name="line.192"></a>
<span class="sourceLineNo">193</span>                writer = new OutputStreamWriter(out, encoding);<a name="line.193"></a>
<span class="sourceLineNo">194</span>                writer.write(xmlProlog.toString());<a name="line.194"></a>
<span class="sourceLineNo">195</span>                if (len &gt; size) {<a name="line.195"></a>
<span class="sourceLineNo">196</span>                    writer.write(cbuf, off + size, len - size);<a name="line.196"></a>
<span class="sourceLineNo">197</span>                }<a name="line.197"></a>
<span class="sourceLineNo">198</span>            }<a name="line.198"></a>
<span class="sourceLineNo">199</span>        }<a name="line.199"></a>
<span class="sourceLineNo">200</span>    }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span>    /**<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * Writes the characters to the underlying writer, detecting encoding.<a name="line.203"></a>
<span class="sourceLineNo">204</span>     *<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * @param cbuf the buffer to write the characters from<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * @param off The start offset<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * @param len The number of characters to write<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * @throws IOException if an error occurs detecting the encoding<a name="line.208"></a>
<span class="sourceLineNo">209</span>     */<a name="line.209"></a>
<span class="sourceLineNo">210</span>    @Override<a name="line.210"></a>
<span class="sourceLineNo">211</span>    public void write(final char[] cbuf, final int off, final int len) throws IOException {<a name="line.211"></a>
<span class="sourceLineNo">212</span>        if (xmlPrologWriter != null) {<a name="line.212"></a>
<span class="sourceLineNo">213</span>            detectEncoding(cbuf, off, len);<a name="line.213"></a>
<span class="sourceLineNo">214</span>        } else {<a name="line.214"></a>
<span class="sourceLineNo">215</span>            writer.write(cbuf, off, len);<a name="line.215"></a>
<span class="sourceLineNo">216</span>        }<a name="line.216"></a>
<span class="sourceLineNo">217</span>    }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span>    static final Pattern ENCODING_PATTERN = XmlStreamReader.ENCODING_PATTERN;<a name="line.219"></a>
<span class="sourceLineNo">220</span>}<a name="line.220"></a>




























































</pre>
</div>
</body>
</html>
